home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / g_man / cat3 / OpenGL / glclear.z / glclear
Encoding:
Text File  |  2001-04-17  |  6.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4. ggggllllCCCClllleeeeaaaarrrr((((3333GGGG))))                    OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee                    ggggllllCCCClllleeeeaaaarrrr((((3333GGGG))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ggggllllCCCClllleeeeaaaarrrr - clear buffers to preset values
  10.  
  11.  
  12. CCCC SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  13.      void ggggllllCCCClllleeeeaaaarrrr( GLbitfield _m_a_s_k )
  14.  
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  17.      _m_a_s_k  Bitwise OR of masks that indicate the buffers to be cleared.  The
  18.            four masks are GGGGLLLL____CCCCOOOOLLLLOOOORRRR____BBBBUUUUFFFFFFFFEEEERRRR____BBBBIIIITTTT, GGGGLLLL____DDDDEEEEPPPPTTTTHHHH____BBBBUUUUFFFFFFFFEEEERRRR____BBBBIIIITTTT,
  19.            GGGGLLLL____AAAACCCCCCCCUUUUMMMM____BBBBUUUUFFFFFFFFEEEERRRR____BBBBIIIITTTT, and GGGGLLLL____SSSSTTTTEEEENNNNCCCCIIIILLLL____BBBBUUUUFFFFFFFFEEEERRRR____BBBBIIIITTTT.
  20.  
  21. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.      ggggllllCCCClllleeeeaaaarrrr sets the bitplane area of the window to values previously
  23.      selected by ggggllllCCCClllleeeeaaaarrrrCCCCoooolllloooorrrr, ggggllllCCCClllleeeeaaaarrrrIIIInnnnddddeeeexxxx, ggggllllCCCClllleeeeaaaarrrrDDDDeeeepppptttthhhh, ggggllllCCCClllleeeeaaaarrrrSSSStttteeeennnncccciiiillll, and
  24.      ggggllllCCCClllleeeeaaaarrrrAAAAccccccccuuuummmm.  Multiple color buffers can be cleared simultaneously by
  25.      selecting more than one buffer at a time using ggggllllDDDDrrrraaaawwwwBBBBuuuuffffffffeeeerrrr.
  26.  
  27.      The pixel ownership test, the scissor test, dithering, and the buffer
  28.      writemasks affect the operation of ggggllllCCCClllleeeeaaaarrrr.  The scissor box bounds the
  29.      cleared region.  Alpha function, blend function, logical operation,
  30.      stenciling, texture mapping, and depth-buffering are ignored by ggggllllCCCClllleeeeaaaarrrr.
  31.  
  32.      ggggllllCCCClllleeeeaaaarrrr takes a single argument that is the bitwise OR of several values
  33.      indicating which buffer is to be cleared.
  34.  
  35.      The values are as follows:
  36.  
  37.      GGGGLLLL____CCCCOOOOLLLLOOOORRRR____BBBBUUUUFFFFFFFFEEEERRRR____BBBBIIIITTTT         Indicates the buffers currently enabled for
  38.                                  color writing.
  39.  
  40.      GGGGLLLL____DDDDEEEEPPPPTTTTHHHH____BBBBUUUUFFFFFFFFEEEERRRR____BBBBIIIITTTT         Indicates the depth buffer.
  41.  
  42.      GGGGLLLL____AAAACCCCCCCCUUUUMMMM____BBBBUUUUFFFFFFFFEEEERRRR____BBBBIIIITTTT         Indicates the accumulation buffer.
  43.  
  44.      GGGGLLLL____SSSSTTTTEEEENNNNCCCCIIIILLLL____BBBBUUUUFFFFFFFFEEEERRRR____BBBBIIIITTTT       Indicates the stencil buffer.
  45.  
  46.      The value to which each buffer is cleared depends on the setting of the
  47.      clear value for that buffer.
  48.  
  49. NNNNOOOOTTTTEEEESSSS
  50.      If a buffer is not present, then a ggggllllCCCClllleeeeaaaarrrr directed at that buffer has no
  51.      effect.
  52.  
  53. EEEERRRRRRRROOOORRRRSSSS
  54.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____VVVVAAAALLLLUUUUEEEE is generated if any bit other than the four defined bits
  55.      is set in _m_a_s_k.
  56.  
  57.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is generated if ggggllllCCCClllleeeeaaaarrrr is executed between the
  58.      execution of ggggllllBBBBeeeeggggiiiinnnn and the corresponding execution of ggggllllEEEEnnnndddd.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ggggllllCCCClllleeeeaaaarrrr((((3333GGGG))))                    OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee                    ggggllllCCCClllleeeeaaaarrrr((((3333GGGG))))
  71.  
  72.  
  73.  
  74. AAAASSSSSSSSOOOOCCCCIIIIAAAATTTTEEEEDDDD GGGGEEEETTTTSSSS
  75.      ggggllllGGGGeeeetttt with argument GGGGLLLL____AAAACCCCCCCCUUUUMMMM____CCCCLLLLEEEEAAAARRRR____VVVVAAAALLLLUUUUEEEE
  76.      ggggllllGGGGeeeetttt with argument GGGGLLLL____DDDDEEEEPPPPTTTTHHHH____CCCCLLLLEEEEAAAARRRR____VVVVAAAALLLLUUUUEEEE
  77.      ggggllllGGGGeeeetttt with argument GGGGLLLL____IIIINNNNDDDDEEEEXXXX____CCCCLLLLEEEEAAAARRRR____VVVVAAAALLLLUUUUEEEE
  78.      ggggllllGGGGeeeetttt with argument GGGGLLLL____CCCCOOOOLLLLOOOORRRR____CCCCLLLLEEEEAAAARRRR____VVVVAAAALLLLUUUUEEEE
  79.      ggggllllGGGGeeeetttt with argument GGGGLLLL____SSSSTTTTEEEENNNNCCCCIIIILLLL____CCCCLLLLEEEEAAAARRRR____VVVVAAAALLLLUUUUEEEE
  80.  
  81.  
  82. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  83.      ggggllllCCCClllleeeeaaaarrrrAAAAccccccccuuuummmm, ggggllllCCCClllleeeeaaaarrrrCCCCoooolllloooorrrr, ggggllllCCCClllleeeeaaaarrrrDDDDeeeepppptttthhhh, ggggllllCCCClllleeeeaaaarrrrIIIInnnnddddeeeexxxx, ggggllllCCCClllleeeeaaaarrrrSSSStttteeeennnncccciiiillll,
  84.      ggggllllCCCCoooolllloooorrrrMMMMaaaasssskkkk, ggggllllDDDDeeeepppptttthhhhMMMMaaaasssskkkk, ggggllllDDDDrrrraaaawwwwBBBBuuuuffffffffeeeerrrr, ggggllllSSSScccciiiissssssssoooorrrr, ggggllllSSSStttteeeennnncccciiiillllMMMMaaaasssskkkk
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.